Thanks for the PR. I checked this locally on macOS arm64 and I think there are two separate issues here.

First, the README build-from-source path is indeed outdated. The actual full distribution is produced as target/apache-hugegraph-${version}.tar.gz, and the server scripts are under apache-hugegraph-${version}/apache-hugegraph-server-${version}/bin/, not directly under install-dist/target/hugegraph-{version}. This part should be fixed as a documentation-only change and does not require adding a new dependency.

Second, the Apple Silicon Gremlin Console failure is real, but it is a separate compatibility problem in the current TinkerPop 3.5.1 / JLine / Jansi stack. Adding jansi:2.4.0 may be a possible workaround, but it is not the minimal fix for the README issue itself. If we want to claim that bundled bin/gremlin-console.sh works on Apple Silicon, we should add a macOS arm64 smoke test that actually runs the console, for example on macos-15:

VERSION=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout)
SERVER_DIR="hugegraph-server/apache-hugegraph-server-${VERSION}"
printf "println \"gremlin-console-smoke-ok\"\n" > "$RUNNER_TEMP/gremlin-console-smoke.groovy"
"${SERVER_DIR}/bin/gremlin-console.sh" -- -e "$RUNNER_TEMP/gremlin-console-smoke.groovy"

Also, we are preparing to upgrade TinkerPop to 3.8. Since the official TinkerPop 3.8 Gremlin Console artifacts are already available and the current TinkerPop download page lists Gremlin Console / Server compatibility with Java 11/17, I think we should first verify whether the TinkerPop 3.8 upgrade already resolves the Jansi/JLine native-library issue before introducing a new direct dependency here.

So I would suggest splitting this PR:

1. README path correction only, no dependency change.
2. A separate Apple Silicon Gremlin Console compatibility fix, with macOS arm64 CI coverage if we decide to support the bundled console before the TinkerPop upgrade.

Thanks @imbajin for the feedback.
I will create a separate ticket and PR for Mac issue. I will keep only readme changes in here.

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 1.56%. Comparing base (8d095e1) to head (644b437).
⚠️ Report is 1 commits behind head on master.

❗ There is a different number of reports uploaded between BASE (8d095e1) and HEAD (644b437). Click for more details.

HEAD has 2 uploads less than BASE

Flag	BASE (8d095e1)	HEAD (644b437)
	4	2

@@             Coverage Diff              @@
##             master   #3022       +/-   ##
============================================
- Coverage     36.15%   1.56%   -34.59%     
+ Complexity      403      43      -360     
============================================
  Files           812     781       -31     
  Lines         68307   65525     -2782     
  Branches       8927    8457      -470     
============================================
- Hits          24694    1026    -23668     
- Misses        40978   64413    +23435     
+ Partials       2635      86     -2549     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Thanks for the PR. I checked this locally on macOS arm64 and I think there are two separate issues here.

First, the README build-from-source path is indeed outdated. The actual full distribution is produced as target/apache-hugegraph-${version}.tar.gz, and the server scripts are under apache-hugegraph-${version}/apache-hugegraph-server-${version}/bin/, not directly under install-dist/target/hugegraph-{version}. This part should be fixed as a documentation-only change and does not require adding a new dependency.

Second, the Apple Silicon Gremlin Console failure is real, but it is a separate compatibility problem in the current TinkerPop 3.5.1 / JLine / Jansi stack. Adding jansi:2.4.0 may be a possible workaround, but it is not the minimal fix for the README issue itself. If we want to claim that bundled bin/gremlin-console.sh works on Apple Silicon, we should add a macOS arm64 smoke test that actually runs the console, for example on macos-15:

VERSION=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout)
SERVER_DIR="hugegraph-server/apache-hugegraph-server-${VERSION}"
printf "println \"gremlin-console-smoke-ok\"\n" > "$RUNNER_TEMP/gremlin-console-smoke.groovy"
"${SERVER_DIR}/bin/gremlin-console.sh" -- -e "$RUNNER_TEMP/gremlin-console-smoke.groovy"

Also, we are preparing to upgrade TinkerPop to 3.8. Since the official TinkerPop 3.8 Gremlin Console artifacts are already available and the current TinkerPop download page lists Gremlin Console / Server compatibility with Java 11/17, I think we should first verify whether the TinkerPop 3.8 upgrade already resolves the Jansi/JLine native-library issue before introducing a new direct dependency here.

So I would suggest splitting this PR:

1. README path correction only, no dependency change.
2. A separate Apple Silicon Gremlin Console compatibility fix, with macOS arm64 CI coverage if we decide to support the bundled console before the TinkerPop upgrade.

Hi @imbajin,
I have implemented the review comments. Separated the README.md changes from mac m4 issues.

Created separate issue #3031 for gremlin-console.sh errors on Mac M4